home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-20 / bb21tu.zip / ACTION.DOC < prev    next >
Text File  |  1991-07-23  |  8KB  |  238 lines
  1. The action file includes all sorts of things to be done with messages.  The
  2. operations are shown below.  {search} is any search for a message as
  3. specified in SEARCH.DOC.  Comments are any line that starts with ; or *
  4. There are two types of operations:  Immediate and Deferred.  Immediate
  5. actions occur on messages being received.  Deferred actions occur only when
  6. the proper "A" command is executed.
  7.  
  8. IMMEDIATE ACTIONS
  9. --------- -------
  10.  
  11.     HOLD {search}
  12.  
  13.       This says to hold a message that matches the search.  Files will be
  14.       marked as held by SYSOP.  {search} is any search for a message as
  15.       specified in SEARCH.DOC.
  16.  
  17.       Example:
  18.  
  19.           HOLD < AA4RE
  20.  
  21.           Holds all messages from AA4RE
  22.  
  23.     REVIEW {search}
  24.  
  25.       This says to put a message in review status that matches the search.
  26.       {search} is any search for a message as specified in SEARCH.DOC.
  27.  
  28.       Example:
  29.  
  30.           REVIEW % AA4RE
  31.  
  32.           Mark for review all messages created locally at AA4RE
  33.  
  34.     HOLD_OLD {search}
  35.  
  36.       This says to hold a message that matches the search but reason will
  37.       be too old rather than help by operator.  {search} is any search for
  38.       a message as specified in SEARCH.DOC.
  39.  
  40.       Example:
  41.  
  42.           HOLD < AA4RE
  43.  
  44.           Holds all messages from AA4RE
  45.  
  46.     REJECT {search}
  47.  
  48.       This says to reject a message that matches the search.  A rejected
  49.       message may not even arrive at the BBS.  Also see the parameter
  50.       REJECT_ACTION in PARMS.DOC.  {search} is any search for a message as
  51.       specified in SEARCH.DOC.
  52.  
  53.       Example:
  54.  
  55.           REJECT > SALE & @ USA
  56.  
  57.           Rejects all messages addressed to SALE @ USA
  58.  
  59.       Note:  The first pass at a reject action occurs when just the
  60.       the send command is received.  Some fields are not available
  61.       for testing like SUBJECT and FROM-BBS.
  62.  
  63.     DENY_NEW_MSG {message_num} {search}
  64.  
  65.       This says to not permit a user to originate a message at this BBS.
  66.       The {message_num} parameter indicates which message is to be
  67.       displayed if the {search} is met.  It will be between 0 at 9. The
  68.       real message number will be 140 + this parameter.  {search} is any
  69.       search for a message as specified in SEARCH.DOC.
  70.  
  71.       Examples:
  72.  
  73.           DENY_NEW_MSG 3 > SALE & @ USA
  74.  
  75.              Rejects all messages addressed to SALE @ USA and uses
  76.              message # 143
  77.  
  78.           DENY_NEW_MSG 2 C U & ^ > SYSOP
  79.  
  80.              Reject any messages from new or unregistered users unless
  81.              addressed to SYSOPand uses message # 142
  82.  
  83.       Note:  The deny action will be checked twice.  Once before the
  84.       subject is available and once afterwards.
  85.  
  86.       Note 2:  DENY_NEW_MSG should appear before REJECT and HOLD in the
  87.       ACTION.BB
  88.  
  89.     CHANGE_ADR {search} => {address}
  90.  
  91.       Changes an address.  {search} is any search for a message as
  92.       specified in SEARCH.DOC.  {address} is a standard packet address in
  93.       the form of "xxxx @ yyyy.zzzz". xxxx must be supplied and valid.  The
  94.       others can be omitted but the defaults may not fit what you want.
  95.       Any of the three (xxxx, yyyy, or zzzz) can be "=" which means leave
  96.       the same as before or the special word "NONE" which means to erase
  97.       this part of the address.
  98.  
  99.       Examples:
  100.  
  101.          CHANGE_ADR & @ USA => = @ ALLUS
  102.          CHANGE_ADR > 4SALE & @ USA => SALE @ =
  103.  
  104.     DISTRIBUTE {name} {search}
  105.  
  106.       Specifies which distribution/carbon-copy list is to be used.  If
  107.       {name} is a simple word, it will follow the normal name resolution.
  108.       If {name} is an actual file, that will supercede the name resolution
  109.       system.  {search} is any search for a message as specified in
  110.       SEARCH.DOC.
  111.  
  112.       Examples:
  113.  
  114.           DISTRIBUTE ALLCA @ ALLUS
  115.  
  116.              Use ALLCA for messages addressed to ALLUS.  First ALLCA.CC
  117.              will be tried then ALLCA.DIS
  118.  
  119.           DISTRIBUTE C:\BB\DISTINFO\ALLCA.DIS @ ALLUS
  120.  
  121.              Use the file C:\BB\DISTINFO\ALLCA.DIS for messages addressed
  122.              to ALLUS.
  123.  
  124.  
  125.  
  126. DEFERRED ACTIONS
  127. -------- -------
  128.  
  129.     MAKE_FILE            {fileid} {search}
  130.     MAKE_FILE_REPLACE
  131.     MAKE_FILE_APPEND
  132.  
  133.       Makes a file from a message.  {fileid} is the file to be used be
  134.       used.  Susbstitution parameters that are the same as for messages
  135.       (see MESSAGE.BB) can be used.  The file must not exist for MAKE_FILE.
  136.       If MAKE_FILE_REPLACE is used, then if the file already exists, it
  137.       will be replaced.  If MAKE_FILE_APPEND is used, the the message will
  138.       be added at the end of the file; if the file doesn't exist, it will
  139.       be created.  {search} is any search for a message as specified in
  140.       SEARCH.DOC.
  141.  
  142.       Examples:
  143.  
  144.          MAKE_FILE C:\RACES\$b > RACES & $ RACESBUL.*
  145.  
  146.          Change anything addressed to RACES with a BID of RACESBUL into a
  147.          file and stick it into the RACES subdirectory
  148.  
  149.          MAKE_FILE_REPLACE C:\ARRL\ARRLPROP $ ARLP*
  150.  
  151.          A propagation bulletin will replace its predessor in the file
  152.          called ARRLPROP.
  153.  
  154.     CLEAN_MSGS {type} {search}
  155.  
  156.       Used for general message housekeeping.  Its purpose is to remove
  157.       superceded messages like AMSAT orbitial data.  {type} indicates ARRL,
  158.       AMSAT, RACES, RTTYDX, GENERATE, or DATE.  This refers to how the BID
  159.       is used.  Both RACES and ARRL bids end in numbers but the ARRL
  160.       numbers are recycled at the end of the year.  AMSAT news and orbital
  161.       data have the format that looks like xxx-ddd.vv where the applicable
  162.       number (ddd) is just in front of the "."  RTTYDX uses a format of
  163.       xxxxxxxdddx.  If the GENERATE {type} is used, the standarded
  164.       generated bid of dddddd_bbs is assumed.  If {type} is DATE, then only
  165.       the last message received will be kept and the bid is ignored.
  166.       {search} is any search for a message as specified in SEARCH.DOC.
  167.  
  168.       Examples:
  169.  
  170.          CLEAN_MSGS ARRL  $ ARLP###
  171.          CLEAN_MSGS ARRL  $ ARLD###
  172.          CLEAN_MSGS ARRL  $ ARLS###
  173.          CLEAN_MSGS AMSAT $ ORBS-###.*
  174.          CLEAN_MSGS AMSAT $ ANS-###.##
  175.          CLEAN_MSGS RACES $ RACESBUL.###
  176.          CLEAN_MSGS RTTYDX $ RTDX####=
  177.  
  178.       These examples clean away old ARRL DX bulletins, prop bulletins,
  179.       satellite bulletins, AMSAT orbitial data, AMSAT news, and RACES
  180.       bulletins.
  181.  
  182.       Note 1:  Both AMSAT and ARRL types have special code to cover the
  183.       yearend wrap (Example: when ARLD052 is followed by ARLD001)
  184.  
  185.       Note 2:  GENERATE has special code to ignore the distant BBS doing
  186.       a message renumber.
  187.  
  188.  
  189. ORDERING
  190. --------
  191.  
  192. The first match that is seen will be acted on.  Example
  193.  
  194.    REJECT > SALE & @ USA
  195.    HOLD @ USA
  196.  
  197. A message addressed to SALE @ USA will be rejected because the REJECT is
  198. seen first.  The message addressed to ALL @ USA will just be held.
  199.  
  200. Also, the order is import for CHANGE_ADR and HOLD.  Example:
  201.  
  202.    HOLD @ ALLUS
  203.    CHANGE @ USA => = @ ALLUS
  204.  
  205. Messages @ USA will NOT be held since the change action is executed
  206. after the HOLD action.
  207.  
  208. One further example:
  209.  
  210.    CHANGE_ADR > SYSOP & @ AA4RE => AA4RE
  211.    CHANGE_ADR @ AA4RE => = @ NONE
  212.  
  213.       If a message comes in addressed to SYSOP @ AA4RE, it is readdressed
  214.       to AA4RE @ AA4RE.  Why not AA4RE @ (blank)?  The first line satisfied
  215.       the search so the search stopped.  The correct way to do this is:
  216.  
  217.    CHANGE_ADR > SYSOP & @ AA4RE => AA4RE @ NONE
  218.    CHANGE_ADR @ AA4RE => = @ NONE
  219.  
  220. You must make all the action happen with the one line!
  221.  
  222.  
  223. NEGATION
  224. --------
  225.  
  226. Putting a NO in front of a word will negate it.  Example:
  227.  
  228.    NOHOLD > SALE & @ USA
  229.    HOLD @ USA
  230.  
  231. A message addressed to SALE @ USA will go thru because the NOHOLD is
  232. seen first.  The message addressed to ALL @ USA will be held.
  233.  
  234. Note:  NOCHANGE_ADR does not require the => xxxx @ yyyy.ZZZZ portion.
  235. Example:
  236.  
  237.    NOCHANGE > ALL & @ USA
  238.